<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.14"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>SPHinXsys: SPH::BaseParticleData Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectlogo"><img alt="Logo" src="logo.png"/></td>
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">SPHinXsys
   &#160;<span id="projectnumber">alpha version</span>
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.14 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div id="nav-path" class="navpath">
  <ul>
<li class="navelem"><a class="el" href="namespace_s_p_h.html">SPH</a></li><li class="navelem"><a class="el" href="class_s_p_h_1_1_base_particle_data.html">BaseParticleData</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pub-attribs">Public Attributes</a> &#124;
<a href="#pro-static-attribs">Static Protected Attributes</a> &#124;
<a href="class_s_p_h_1_1_base_particle_data-members.html">List of all members</a>  </div>
  <div class="headertitle">
<div class="title">SPH::BaseParticleData Class Reference</div>  </div>
</div><!--header-->
<div class="contents">

<p>A based particle with essential data for all types of particles.  
 <a href="class_s_p_h_1_1_base_particle_data.html#details">More...</a></p>

<p><code>#include &lt;<a class="el" href="base__particles_8h_source.html">base_particles.h</a>&gt;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a9542ff167c621221fecf1193d4feef49"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_p_h_1_1_base_particle_data.html#a9542ff167c621221fecf1193d4feef49">BaseParticleData</a> (Vecd position, Real Vol_0, Real sigma_0)</td></tr>
<tr class="separator:a9542ff167c621221fecf1193d4feef49"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
Public Attributes</h2></td></tr>
<tr class="memitem:aafb213a4275af2b66d814c7cc682bfef"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classsize__t.html">size_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_p_h_1_1_base_particle_data.html#aafb213a4275af2b66d814c7cc682bfef">particle_id_</a></td></tr>
<tr class="separator:aafb213a4275af2b66d814c7cc682bfef"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa8e7591289901aa83f2065f28fef38e6"><td class="memItemLeft" align="right" valign="top">Point&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_p_h_1_1_base_particle_data.html#aa8e7591289901aa83f2065f28fef38e6">pos_n_</a></td></tr>
<tr class="separator:aa8e7591289901aa83f2065f28fef38e6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3edae9988c0c2100b8314650b499fc1b"><td class="memItemLeft" align="right" valign="top"><a id="a3edae9988c0c2100b8314650b499fc1b"></a>
Point&#160;</td><td class="memItemRight" valign="bottom"><b>pos_0_</b></td></tr>
<tr class="separator:a3edae9988c0c2100b8314650b499fc1b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a45a550ea7bba4e081944c32329c00325"><td class="memItemLeft" align="right" valign="top">Vecd&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_p_h_1_1_base_particle_data.html#a45a550ea7bba4e081944c32329c00325">vel_n_</a></td></tr>
<tr class="separator:a45a550ea7bba4e081944c32329c00325"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2c7e365d8c4bcb62f3babdbef6a678fd"><td class="memItemLeft" align="right" valign="top"><a id="a2c7e365d8c4bcb62f3babdbef6a678fd"></a>
Vecd&#160;</td><td class="memItemRight" valign="bottom"><b>dvel_dt_</b></td></tr>
<tr class="separator:a2c7e365d8c4bcb62f3babdbef6a678fd"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad6192ef8c12ef0b3c14600ddcb5dfd01"><td class="memItemLeft" align="right" valign="top"><a id="ad6192ef8c12ef0b3c14600ddcb5dfd01"></a>
Vecd&#160;</td><td class="memItemRight" valign="bottom"><b>dvel_dt_others_</b></td></tr>
<tr class="separator:ad6192ef8c12ef0b3c14600ddcb5dfd01"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae25734347aeb43d20fd21030ba052763"><td class="memItemLeft" align="right" valign="top">Real&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_p_h_1_1_base_particle_data.html#ae25734347aeb43d20fd21030ba052763">Vol_</a></td></tr>
<tr class="separator:ae25734347aeb43d20fd21030ba052763"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:adba1a3ee3aacf49840a556bc93e0b6a5"><td class="memItemLeft" align="right" valign="top"><a id="adba1a3ee3aacf49840a556bc93e0b6a5"></a>
Real&#160;</td><td class="memItemRight" valign="bottom"><b>Vol_0_</b></td></tr>
<tr class="separator:adba1a3ee3aacf49840a556bc93e0b6a5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a45d328a3964af18dea500c3cf9aeaad6"><td class="memItemLeft" align="right" valign="top">Real&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_p_h_1_1_base_particle_data.html#a45d328a3964af18dea500c3cf9aeaad6">sigma_0_</a></td></tr>
<tr class="separator:a45d328a3964af18dea500c3cf9aeaad6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a57cceb08f00702801f25bdc77aa2c5b1"><td class="memItemLeft" align="right" valign="top">Real&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_p_h_1_1_base_particle_data.html#a57cceb08f00702801f25bdc77aa2c5b1">smoothing_length_</a></td></tr>
<tr class="separator:a57cceb08f00702801f25bdc77aa2c5b1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac5110b5c5d5b584668188e8bf463a1d1"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classbool.html">bool</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_p_h_1_1_base_particle_data.html#ac5110b5c5d5b584668188e8bf463a1d1">is_sortable_</a></td></tr>
<tr class="separator:ac5110b5c5d5b584668188e8bf463a1d1"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-static-attribs"></a>
Static Protected Attributes</h2></td></tr>
<tr class="memitem:a7e916ff2d3c61c6639069c4f910eac76"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classsize__t.html">size_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_p_h_1_1_base_particle_data.html#a7e916ff2d3c61c6639069c4f910eac76">total_number_of_particles_</a> = 0</td></tr>
<tr class="separator:a7e916ff2d3c61c6639069c4f910eac76"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>A based particle with essential data for all types of particles. </p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a9542ff167c621221fecf1193d4feef49"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9542ff167c621221fecf1193d4feef49">&#9670;&nbsp;</a></span>BaseParticleData()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">SPH::BaseParticleData::BaseParticleData </td>
          <td>(</td>
          <td class="paramtype">Vecd&#160;</td>
          <td class="paramname"><em>position</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">Real&#160;</td>
          <td class="paramname"><em>Vol_0</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">Real&#160;</td>
          <td class="paramname"><em>sigma_0</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>In this constructor, the particle state is set at rest. </p>

</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a id="ac5110b5c5d5b584668188e8bf463a1d1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac5110b5c5d5b584668188e8bf463a1d1">&#9670;&nbsp;</a></span>is_sortable_</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classbool.html">bool</a> SPH::BaseParticleData::is_sortable_</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Particle with fixed index, not subject to sorting. </p>

</div>
</div>
<a id="aafb213a4275af2b66d814c7cc682bfef"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aafb213a4275af2b66d814c7cc682bfef">&#9670;&nbsp;</a></span>particle_id_</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classsize__t.html">size_t</a> SPH::BaseParticleData::particle_id_</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>For a real particle, it is the index. For a ghost particle, it is the index of its corresponding real particle. </p>

</div>
</div>
<a id="aa8e7591289901aa83f2065f28fef38e6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa8e7591289901aa83f2065f28fef38e6">&#9670;&nbsp;</a></span>pos_n_</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">Point SPH::BaseParticleData::pos_n_</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Current and initial position. </p>

</div>
</div>
<a id="a45d328a3964af18dea500c3cf9aeaad6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a45d328a3964af18dea500c3cf9aeaad6">&#9670;&nbsp;</a></span>sigma_0_</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">Real SPH::BaseParticleData::sigma_0_</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Particle reference number density. </p>

</div>
</div>
<a id="a57cceb08f00702801f25bdc77aa2c5b1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a57cceb08f00702801f25bdc77aa2c5b1">&#9670;&nbsp;</a></span>smoothing_length_</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">Real SPH::BaseParticleData::smoothing_length_</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Smoothing length of the particle. </p>

</div>
</div>
<a id="a7e916ff2d3c61c6639069c4f910eac76"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7e916ff2d3c61c6639069c4f910eac76">&#9670;&nbsp;</a></span>total_number_of_particles_</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classsize__t.html">size_t</a> SPH::BaseParticleData::total_number_of_particles_ = 0</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span><span class="mlabel">protected</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<p>All, including the buffer, particles. </p>

</div>
</div>
<a id="a45a550ea7bba4e081944c32329c00325"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a45a550ea7bba4e081944c32329c00325">&#9670;&nbsp;</a></span>vel_n_</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">Vecd SPH::BaseParticleData::vel_n_</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Current particle velocity and stress-induced and other accelerations. </p>

</div>
</div>
<a id="ae25734347aeb43d20fd21030ba052763"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae25734347aeb43d20fd21030ba052763">&#9670;&nbsp;</a></span>Vol_</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">Real SPH::BaseParticleData::Vol_</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Particle volume and its initial value. </p>

</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li>SPHINXsys/src/shared/particles/<a class="el" href="base__particles_8h_source.html">base_particles.h</a></li>
<li>SPHINXsys/src/shared/particles/<a class="el" href="base__particles_8cpp.html">base_particles.cpp</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.14
</small></address>
</body>
</html>
